Managed Service for Trino API, gRPC: CatalogService.Update
- gRPC request
- UpdateCatalogRequest
- CatalogUpdateSpec
- Connector
- HiveConnector
- Metastore
- HiveMetastore
- FileSystem
- S3FileSystem
- ExternalS3FileSystem
- IcebergConnector
- DeltaLakeConnector
- PostgresqlConnector
- PostgresqlConnection
- OnPremise
- ConnectionManager
- ClickhouseConnector
- ClickhouseConnection
- OnPremise
- ConnectionManager
- TPCHConnector
- TPCDSConnector
- OracleConnector
- OracleConnection
- OnPremise
- SQLServerConnector
- SQLServerConnection
- OnPremise
- HudiConnector
- operation.Operation
- UpdateCatalogMetadata
- Catalog
- Connector
- HiveConnector
- Metastore
- HiveMetastore
- FileSystem
- S3FileSystem
- ExternalS3FileSystem
- IcebergConnector
- DeltaLakeConnector
- PostgresqlConnector
- PostgresqlConnection
- OnPremise
- ConnectionManager
- ClickhouseConnector
- ClickhouseConnection
- OnPremise
- ConnectionManager
- TPCHConnector
- TPCDSConnector
- OracleConnector
- OracleConnection
- OnPremise
- SQLServerConnector
- SQLServerConnection
- OnPremise
- HudiConnector
Updates the specified Trino Catalog.
gRPC request
rpc Update (UpdateCatalogRequest) returns (operation.Operation)
UpdateCatalogRequest
{
"cluster_id": "string",
"catalog_id": "string",
"update_mask": "google.protobuf.FieldMask",
"catalog": {
"name": "string",
"connector": {
// Includes only one of the fields `hive`, `iceberg`, `delta_lake`, `postgresql`, `clickhouse`, `tpch`, `tpcds`, `oracle`, `sqlserver`, `hudi`
"hive": {
"metastore": {
// Includes only one of the fields `hive`
"hive": {
// Includes only one of the fields `uri`
"uri": "string"
// end of the list of possible fields
}
// end of the list of possible fields
},
"filesystem": {
// Includes only one of the fields `s3`, `external_s3`
"s3": "S3FileSystem",
"external_s3": {
"aws_access_key": "string",
"aws_secret_key": "string",
"aws_endpoint": "string",
"aws_region": "string"
}
// end of the list of possible fields
},
"additional_properties": "map<string, string>"
},
"iceberg": {
"metastore": {
// Includes only one of the fields `hive`
"hive": {
// Includes only one of the fields `uri`
"uri": "string"
// end of the list of possible fields
}
// end of the list of possible fields
},
"filesystem": {
// Includes only one of the fields `s3`, `external_s3`
"s3": "S3FileSystem",
"external_s3": {
"aws_access_key": "string",
"aws_secret_key": "string",
"aws_endpoint": "string",
"aws_region": "string"
}
// end of the list of possible fields
},
"additional_properties": "map<string, string>"
},
"delta_lake": {
"metastore": {
// Includes only one of the fields `hive`
"hive": {
// Includes only one of the fields `uri`
"uri": "string"
// end of the list of possible fields
}
// end of the list of possible fields
},
"filesystem": {
// Includes only one of the fields `s3`, `external_s3`
"s3": "S3FileSystem",
"external_s3": {
"aws_access_key": "string",
"aws_secret_key": "string",
"aws_endpoint": "string",
"aws_region": "string"
}
// end of the list of possible fields
},
"additional_properties": "map<string, string>"
},
"postgresql": {
"connection": {
// Includes only one of the fields `on_premise`, `connection_manager`
"on_premise": {
"connection_url": "string",
"user_name": "string",
"password": "string"
},
"connection_manager": {
"connection_id": "string",
"database": "string",
"connection_properties": "map<string, string>"
}
// end of the list of possible fields
},
"additional_properties": "map<string, string>"
},
"clickhouse": {
"connection": {
// Includes only one of the fields `on_premise`, `connection_manager`
"on_premise": {
"connection_url": "string",
"user_name": "string",
"password": "string"
},
"connection_manager": {
"connection_id": "string",
"database": "string",
"connection_properties": "map<string, string>"
}
// end of the list of possible fields
},
"additional_properties": "map<string, string>"
},
"tpch": {
"additional_properties": "map<string, string>"
},
"tpcds": {
"additional_properties": "map<string, string>"
},
"oracle": {
"connection": {
// Includes only one of the fields `on_premise`
"on_premise": {
"connection_url": "string",
"user_name": "string",
"password": "string"
}
// end of the list of possible fields
},
"additional_properties": "map<string, string>"
},
"sqlserver": {
"connection": {
// Includes only one of the fields `on_premise`
"on_premise": {
"connection_url": "string",
"user_name": "string",
"password": "string"
}
// end of the list of possible fields
},
"additional_properties": "map<string, string>"
},
"hudi": {
"metastore": {
// Includes only one of the fields `hive`
"hive": {
// Includes only one of the fields `uri`
"uri": "string"
// end of the list of possible fields
}
// end of the list of possible fields
},
"filesystem": {
// Includes only one of the fields `s3`, `external_s3`
"s3": "S3FileSystem",
"external_s3": {
"aws_access_key": "string",
"aws_secret_key": "string",
"aws_endpoint": "string",
"aws_region": "string"
}
// end of the list of possible fields
},
"additional_properties": "map<string, string>"
}
// end of the list of possible fields
},
"description": "string",
"labels": "map<string, string>"
}
}
|
Field |
Description |
|
cluster_id |
string Required field. ID of the Trino Cluster that contains the catalog to update. |
|
catalog_id |
string Required field. ID of the catalog to update. |
|
update_mask |
Required field. Field mask that specifies which fields of the catalog should be updated. |
|
catalog |
Required field. New values for the specified fields. |
CatalogUpdateSpec
CatalogUpdateSpec defines changes to an existing catalog.
Fields are optional and only provided fields will be updated.
|
Field |
Description |
|
name |
string New name of the catalog. |
|
connector |
Updated connector configuration. |
|
description |
string Description of the catalog. |
|
labels |
object (map<string, string>) Labels associated with the catalog. |
Connector
Connector configuration. Exactly one connector type must be specified.
|
Field |
Description |
|
hive |
Hive connector configuration. Includes only one of the fields |
|
iceberg |
Iceberg connector configuration. Includes only one of the fields |
|
delta_lake |
Delta Lake connector configuration. Includes only one of the fields |
|
postgresql |
PostgreSQL connector configuration. Includes only one of the fields |
|
clickhouse |
ClickHouse connector configuration. Includes only one of the fields |
|
tpch |
TPC-H connector for synthetic benchmarking. Includes only one of the fields |
|
tpcds |
TPC-DS connector for synthetic benchmarking. Includes only one of the fields |
|
oracle |
Oracle connector configuration for connecting to Oracle Database instances. Includes only one of the fields |
|
sqlserver |
SQLServer connector configuration for connecting to SQLServer Database instances. Includes only one of the fields |
|
hudi |
Hudi connector configuration. Includes only one of the fields |
HiveConnector
|
Field |
Description |
|
metastore |
Required field. Metastore configuration. |
|
filesystem |
Required field. File system configuration. |
|
additional_properties |
object (map<string, string>) Additional properties. |
Metastore
Metastore configuration.
|
Field |
Description |
|
hive |
Includes only one of the fields |
HiveMetastore
Configuration of Hive's metastore type.
|
Field |
Description |
|
uri |
string URI or cluster ID of the Hive Metastore. Includes only one of the fields |
FileSystem
Configuration of file system used by a connector.
|
Field |
Description |
|
s3 |
Includes only one of the fields |
|
external_s3 |
Includes only one of the fields |
S3FileSystem
Describes YandexCloud native S3 file system.
Currently does not require configuration.
|
Field |
Description |
|
Empty |
|
ExternalS3FileSystem
Describes External S3 compatible file system.
|
Field |
Description |
|
aws_access_key |
string Required field. |
|
aws_secret_key |
string Required field. |
|
aws_endpoint |
string Required field. |
|
aws_region |
string Required field. |
IcebergConnector
|
Field |
Description |
|
metastore |
Required field. Metastore configuration. |
|
filesystem |
Required field. File system configuration. |
|
additional_properties |
object (map<string, string>) Additional properties. |
DeltaLakeConnector
|
Field |
Description |
|
metastore |
Required field. Metastore configuration. |
|
filesystem |
Required field. File system configuration. |
|
additional_properties |
object (map<string, string>) Additional properties. |
PostgresqlConnector
|
Field |
Description |
|
connection |
Connection configuration. |
|
additional_properties |
object (map<string, string>) Additional properties. |
PostgresqlConnection
|
Field |
Description |
|
on_premise |
Includes only one of the fields |
|
connection_manager |
Includes only one of the fields |
OnPremise
|
Field |
Description |
|
connection_url |
string Required field. Connection to the Postgresql. |
|
user_name |
string Required field. Name of the Postgresql user. |
|
password |
string Required field. Password of the Postgresql user. |
ConnectionManager
|
Field |
Description |
|
connection_id |
string Required field. Connection ID. |
|
database |
string Required field. Database. |
|
connection_properties |
object (map<string, string>) Additional connection properties. |
ClickhouseConnector
|
Field |
Description |
|
connection |
Connection configuration. |
|
additional_properties |
object (map<string, string>) Additional properties. |
ClickhouseConnection
|
Field |
Description |
|
on_premise |
Includes only one of the fields |
|
connection_manager |
Includes only one of the fields |
OnPremise
|
Field |
Description |
|
connection_url |
string Required field. Connection to the Clickhouse. |
|
user_name |
string Required field. Name of the Clickhouse user. |
|
password |
string Required field. Password of the Clickhouse user. |
ConnectionManager
|
Field |
Description |
|
connection_id |
string Required field. Connection ID. |
|
database |
string Required field. Database. |
|
connection_properties |
object (map<string, string>) Additional connection properties. |
TPCHConnector
|
Field |
Description |
|
additional_properties |
object (map<string, string>) Additional properties. |
TPCDSConnector
|
Field |
Description |
|
additional_properties |
object (map<string, string>) Additional properties. |
OracleConnector
|
Field |
Description |
|
connection |
Connection configuration. |
|
additional_properties |
object (map<string, string>) Additional properties. |
OracleConnection
|
Field |
Description |
|
on_premise |
Includes only one of the fields |
OnPremise
|
Field |
Description |
|
connection_url |
string Required field. Connection to the Oracle. |
|
user_name |
string Required field. Name of the Oracle user. |
|
password |
string Required field. Password of the Oracle user. |
SQLServerConnector
|
Field |
Description |
|
connection |
Connection configuration. |
|
additional_properties |
object (map<string, string>) Additional properties. |
SQLServerConnection
|
Field |
Description |
|
on_premise |
Includes only one of the fields |
OnPremise
|
Field |
Description |
|
connection_url |
string Required field. Connection to the SQLServer. |
|
user_name |
string Required field. Name of the SQLServer user. |
|
password |
string Required field. Password of the SQLServer user. |
HudiConnector
|
Field |
Description |
|
metastore |
Required field. Metastore configuration. |
|
filesystem |
Required field. File system configuration. |
|
additional_properties |
object (map<string, string>) Additional properties. |
operation.Operation
{
"id": "string",
"description": "string",
"created_at": "google.protobuf.Timestamp",
"created_by": "string",
"modified_at": "google.protobuf.Timestamp",
"done": "bool",
"metadata": {
"cluster_id": "string",
"catalog_id": "string"
},
// Includes only one of the fields `error`, `response`
"error": "google.rpc.Status",
"response": {
"id": "string",
"name": "string",
"connector": {
// Includes only one of the fields `hive`, `iceberg`, `delta_lake`, `postgresql`, `clickhouse`, `tpch`, `tpcds`, `oracle`, `sqlserver`, `hudi`
"hive": {
"metastore": {
// Includes only one of the fields `hive`
"hive": {
// Includes only one of the fields `uri`
"uri": "string"
// end of the list of possible fields
}
// end of the list of possible fields
},
"filesystem": {
// Includes only one of the fields `s3`, `external_s3`
"s3": "S3FileSystem",
"external_s3": {
"aws_access_key": "string",
"aws_secret_key": "string",
"aws_endpoint": "string",
"aws_region": "string"
}
// end of the list of possible fields
},
"additional_properties": "map<string, string>"
},
"iceberg": {
"metastore": {
// Includes only one of the fields `hive`
"hive": {
// Includes only one of the fields `uri`
"uri": "string"
// end of the list of possible fields
}
// end of the list of possible fields
},
"filesystem": {
// Includes only one of the fields `s3`, `external_s3`
"s3": "S3FileSystem",
"external_s3": {
"aws_access_key": "string",
"aws_secret_key": "string",
"aws_endpoint": "string",
"aws_region": "string"
}
// end of the list of possible fields
},
"additional_properties": "map<string, string>"
},
"delta_lake": {
"metastore": {
// Includes only one of the fields `hive`
"hive": {
// Includes only one of the fields `uri`
"uri": "string"
// end of the list of possible fields
}
// end of the list of possible fields
},
"filesystem": {
// Includes only one of the fields `s3`, `external_s3`
"s3": "S3FileSystem",
"external_s3": {
"aws_access_key": "string",
"aws_secret_key": "string",
"aws_endpoint": "string",
"aws_region": "string"
}
// end of the list of possible fields
},
"additional_properties": "map<string, string>"
},
"postgresql": {
"connection": {
// Includes only one of the fields `on_premise`, `connection_manager`
"on_premise": {
"connection_url": "string",
"user_name": "string",
"password": "string"
},
"connection_manager": {
"connection_id": "string",
"database": "string",
"connection_properties": "map<string, string>"
}
// end of the list of possible fields
},
"additional_properties": "map<string, string>"
},
"clickhouse": {
"connection": {
// Includes only one of the fields `on_premise`, `connection_manager`
"on_premise": {
"connection_url": "string",
"user_name": "string",
"password": "string"
},
"connection_manager": {
"connection_id": "string",
"database": "string",
"connection_properties": "map<string, string>"
}
// end of the list of possible fields
},
"additional_properties": "map<string, string>"
},
"tpch": {
"additional_properties": "map<string, string>"
},
"tpcds": {
"additional_properties": "map<string, string>"
},
"oracle": {
"connection": {
// Includes only one of the fields `on_premise`
"on_premise": {
"connection_url": "string",
"user_name": "string",
"password": "string"
}
// end of the list of possible fields
},
"additional_properties": "map<string, string>"
},
"sqlserver": {
"connection": {
// Includes only one of the fields `on_premise`
"on_premise": {
"connection_url": "string",
"user_name": "string",
"password": "string"
}
// end of the list of possible fields
},
"additional_properties": "map<string, string>"
},
"hudi": {
"metastore": {
// Includes only one of the fields `hive`
"hive": {
// Includes only one of the fields `uri`
"uri": "string"
// end of the list of possible fields
}
// end of the list of possible fields
},
"filesystem": {
// Includes only one of the fields `s3`, `external_s3`
"s3": "S3FileSystem",
"external_s3": {
"aws_access_key": "string",
"aws_secret_key": "string",
"aws_endpoint": "string",
"aws_region": "string"
}
// end of the list of possible fields
},
"additional_properties": "map<string, string>"
}
// end of the list of possible fields
},
"description": "string",
"labels": "map<string, string>"
}
// end of the list of possible fields
}
An Operation resource. For more information, see Operation.
|
Field |
Description |
|
id |
string ID of the operation. |
|
description |
string Description of the operation. 0-256 characters long. |
|
created_at |
Creation timestamp. |
|
created_by |
string ID of the user or service account who initiated the operation. |
|
modified_at |
The time when the Operation resource was last modified. |
|
done |
bool If the value is |
|
metadata |
Service-specific metadata associated with the operation. |
|
error |
The error result of the operation in case of failure or cancellation. Includes only one of the fields The operation result. |
|
response |
The normal response of the operation in case of success. Includes only one of the fields The operation result. |
UpdateCatalogMetadata
|
Field |
Description |
|
cluster_id |
string ID of the Trino cluster where a catalog is being updated. |
|
catalog_id |
string ID of the catalog that is being updated. |
Catalog
Catalog is a logical Trino catalog backed by a specific connector.
|
Field |
Description |
|
id |
string ID of the catalog. |
|
name |
string Name of the catalog. |
|
connector |
Connector backing this catalog. |
|
description |
string Description of the catalog. |
|
labels |
object (map<string, string>) Labels associated with the catalog. |
Connector
Connector configuration. Exactly one connector type must be specified.
|
Field |
Description |
|
hive |
Hive connector configuration. Includes only one of the fields |
|
iceberg |
Iceberg connector configuration. Includes only one of the fields |
|
delta_lake |
Delta Lake connector configuration. Includes only one of the fields |
|
postgresql |
PostgreSQL connector configuration. Includes only one of the fields |
|
clickhouse |
ClickHouse connector configuration. Includes only one of the fields |
|
tpch |
TPC-H connector for synthetic benchmarking. Includes only one of the fields |
|
tpcds |
TPC-DS connector for synthetic benchmarking. Includes only one of the fields |
|
oracle |
Oracle connector configuration for connecting to Oracle Database instances. Includes only one of the fields |
|
sqlserver |
SQLServer connector configuration for connecting to SQLServer Database instances. Includes only one of the fields |
|
hudi |
Hudi connector configuration. Includes only one of the fields |
HiveConnector
|
Field |
Description |
|
metastore |
Required field. Metastore configuration. |
|
filesystem |
Required field. File system configuration. |
|
additional_properties |
object (map<string, string>) Additional properties. |
Metastore
Metastore configuration.
|
Field |
Description |
|
hive |
Includes only one of the fields |
HiveMetastore
Configuration of Hive's metastore type.
|
Field |
Description |
|
uri |
string URI or cluster ID of the Hive Metastore. Includes only one of the fields |
FileSystem
Configuration of file system used by a connector.
|
Field |
Description |
|
s3 |
Includes only one of the fields |
|
external_s3 |
Includes only one of the fields |
S3FileSystem
Describes YandexCloud native S3 file system.
Currently does not require configuration.
|
Field |
Description |
|
Empty |
|
ExternalS3FileSystem
Describes External S3 compatible file system.
|
Field |
Description |
|
aws_access_key |
string Required field. |
|
aws_secret_key |
string Required field. |
|
aws_endpoint |
string Required field. |
|
aws_region |
string Required field. |
IcebergConnector
|
Field |
Description |
|
metastore |
Required field. Metastore configuration. |
|
filesystem |
Required field. File system configuration. |
|
additional_properties |
object (map<string, string>) Additional properties. |
DeltaLakeConnector
|
Field |
Description |
|
metastore |
Required field. Metastore configuration. |
|
filesystem |
Required field. File system configuration. |
|
additional_properties |
object (map<string, string>) Additional properties. |
PostgresqlConnector
|
Field |
Description |
|
connection |
Connection configuration. |
|
additional_properties |
object (map<string, string>) Additional properties. |
PostgresqlConnection
|
Field |
Description |
|
on_premise |
Includes only one of the fields |
|
connection_manager |
Includes only one of the fields |
OnPremise
|
Field |
Description |
|
connection_url |
string Required field. Connection to the Postgresql. |
|
user_name |
string Required field. Name of the Postgresql user. |
|
password |
string Required field. Password of the Postgresql user. |
ConnectionManager
|
Field |
Description |
|
connection_id |
string Required field. Connection ID. |
|
database |
string Required field. Database. |
|
connection_properties |
object (map<string, string>) Additional connection properties. |
ClickhouseConnector
|
Field |
Description |
|
connection |
Connection configuration. |
|
additional_properties |
object (map<string, string>) Additional properties. |
ClickhouseConnection
|
Field |
Description |
|
on_premise |
Includes only one of the fields |
|
connection_manager |
Includes only one of the fields |
OnPremise
|
Field |
Description |
|
connection_url |
string Required field. Connection to the Clickhouse. |
|
user_name |
string Required field. Name of the Clickhouse user. |
|
password |
string Required field. Password of the Clickhouse user. |
ConnectionManager
|
Field |
Description |
|
connection_id |
string Required field. Connection ID. |
|
database |
string Required field. Database. |
|
connection_properties |
object (map<string, string>) Additional connection properties. |
TPCHConnector
|
Field |
Description |
|
additional_properties |
object (map<string, string>) Additional properties. |
TPCDSConnector
|
Field |
Description |
|
additional_properties |
object (map<string, string>) Additional properties. |
OracleConnector
|
Field |
Description |
|
connection |
Connection configuration. |
|
additional_properties |
object (map<string, string>) Additional properties. |
OracleConnection
|
Field |
Description |
|
on_premise |
Includes only one of the fields |
OnPremise
|
Field |
Description |
|
connection_url |
string Required field. Connection to the Oracle. |
|
user_name |
string Required field. Name of the Oracle user. |
|
password |
string Required field. Password of the Oracle user. |
SQLServerConnector
|
Field |
Description |
|
connection |
Connection configuration. |
|
additional_properties |
object (map<string, string>) Additional properties. |
SQLServerConnection
|
Field |
Description |
|
on_premise |
Includes only one of the fields |
OnPremise
|
Field |
Description |
|
connection_url |
string Required field. Connection to the SQLServer. |
|
user_name |
string Required field. Name of the SQLServer user. |
|
password |
string Required field. Password of the SQLServer user. |
HudiConnector
|
Field |
Description |
|
metastore |
Required field. Metastore configuration. |
|
filesystem |
Required field. File system configuration. |
|
additional_properties |
object (map<string, string>) Additional properties. |