Updating a Trino catalog

If you do not have the Yandex Cloud CLI installed yet, install and initialize it.

By default, the CLI uses the folder specified when creating the profile. To change the default folder, use the yc config set folder-id <folder_ID> command. You can also set a different folder for any specific command using the --folder-name or --folder-id parameter.

1. View the description of the CLI command for updating a Trino catalog:

   yc managed-trino catalog update --help
   

2. View the description of the CLI command for updating a Trino catalog with a specific connector:

   yc managed-trino catalog update <connector_type> --help
   

3. To update the catalog, run this command:

   yc managed-trino catalog update <connector_type> <Trino_catalog_name> \
       --new-name <new_Trino_catalog_name>
   

   You can get the Trino catalog name together with the list of Trino catalogs in the cluster.

   In the command, you can also provide Trino catalog settings depending on the connector type. Learn more about settings for various connector types.

1. Open the current Terraform configuration file that defines your infrastructure.

   For more information about creating this file, see Creating clusters.

2. Edit the Trino catalog settings in the yandex_trino_catalog section:

   resource "yandex_trino_catalog" "<Trino_catalog_name>" {
     ...
     <connector_type> = {
       <Trino_catalog_settings>
     }
   }
   

   Learn more about the Trino catalog settings for various connector types.

3. Make sure the settings are correct.

   1. In the command line, navigate to the directory that contains the current Terraform configuration files defining the infrastructure.

   2. Run this command:

      terraform validate
      

      Terraform will show any errors found in your configuration files.

4. Confirm updating the resources.

   1. Run this command to view the planned changes:

      terraform plan
      

      If you described the configuration correctly, the terminal will display a list of the resources to update and their parameters. This is a verification step that does not apply changes to your resources.

   2. If everything looks correct, apply the changes:

      1. Run this command:

         terraform apply
         

      2. Confirm updating the resources.

      3. Wait for the operation to complete.

1. Get an IAM token for API authentication and put it into the environment variable:

   export IAM_TOKEN="<IAM_token>"
   

2. Use the Catalog.Update method and send the following request, e.g., via cURL:

   Warning

   The API method will assign default values to all the parameters of the object you are modifying unless you explicitly provide them in your request. To avoid this, list the settings you want to change in the updateMask parameter as a single comma-separated string.

   curl \
       --request PATCH \
       --header "Authorization: Bearer $IAM_TOKEN" \
       --header "Content-Type: application/json" \
       --url 'https://trino.api.cloud.yandex.net/managed-trino/v1/clusters/<cluster_ID>/catalogs/<Trino_catalog_ID>' \
       --data '{
                 "updateMask": "catalog.name,catalog.connector.<connector_type>.<path_to_setting>.<setting_1>,catalog.connector.<connector_type>.<path_to_setting>.<setting_2>,...,catalog.connector.<connector_type>.<path_to_setting>.<setting_N>",
                 "catalog": {
                   "name": "<new_Trino_catalog_name>",
                   "connector": {
                     "<connector_type>": {
                       <Trino_catalog_settings_to_update>
                     }
                   }
                 }
               }'
   

   Where updateMask is the list of parameters to update as a single string, separated by commas.

   Learn more about the Trino catalog settings for various connector types.

   You can request the cluster ID with the list of clusters in the folder and the folder ID with the list of Trino catalogs in the cluster.

3. View the server response to make sure the request was successful.

1. Get an IAM token for API authentication and put it into the environment variable:

   export IAM_TOKEN="<IAM_token>"
   

2. Clone the cloudapi repository:

   cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
   

   Below, we assume the repository contents are stored in the ~/cloudapi/ directory.

3. Use the CatalogService.Update call and run the following request, e.g., via gRPCurl:

   Warning

   The API method will assign default values to all the parameters of the object you are modifying unless you explicitly provide them in your request. To avoid this, list the settings you want to change in the update_mask parameter as an array of paths[] strings.

   Format for listing settings

   "update_mask": {
       "paths": [
           "<setting_1>",
           "<setting_2>",
           ...
           "<setting_N>"
       ]
   }
   

   grpcurl \
       -format json \
       -import-path ~/cloudapi/ \
       -import-path ~/cloudapi/third_party/googleapis/ \
       -proto ~/cloudapi/yandex/cloud/trino/v1/catalog_service.proto \
       -rpc-header "Authorization: Bearer $IAM_TOKEN" \
       -d '{
             "cluster_id": "<cluster_ID>",
             "catalog_id": "<Trino_catalog_ID>",
             "update_mask": {
               "paths": [
                 "catalog.name",
                 "catalog.connector.<connector_type>.<path_to_setting>.<setting_1>",
                 "catalog.connector.<connector_type>.<path_to_setting>.<setting_2>",
                 ...
                 "catalog.connector.<connector_type>.<path_to_setting>.<setting_N>"
               ]
             },
             "catalog": {
               "name": "<new_Trino_catalog_name>",
               "connector": {
                 "<connector_type>": {
                   <Trino_catalog_settings_to_update>
                 }
               }
             }
           }' \
       trino.api.cloud.yandex.net:443 \
       yandex.cloud.trino.v1.CatalogService.Update
   

   Where update_mask is the list of parameters to update as an array of paths[] strings.

   Learn more about the Trino catalog settings for various connector types.

   You can request the cluster ID with the list of clusters in the folder and the folder ID with the list of Trino catalogs in the cluster.

4. View the server response to make sure the request was successful.