Managed Service for Trino API, gRPC: CatalogService.List

Статья создана

Yandex Cloud

Обновлена 3 октября 2025 г.

gRPC request
ListCatalogsRequest
ListCatalogsResponse
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

Retrieves a list of Trino Catalog resources.

gRPC request

rpc List (ListCatalogsRequest) returns (ListCatalogsResponse)

ListCatalogsRequest

{
  "cluster_id": "string",
  "page_size": "int64",
  "page_token": "string",
  "filter": "string"
}

Field	Description
cluster_id	string Required field. ID of the cluster to list Trino Catalogs in.
page_size	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 ListCatalogsResponse.next_page_token that can be used to get the next page of results in subsequent list requests.
page_token	string Page token. To get the next page of results, set `page_token` to the ListCatalogsResponse.next_page_token returned by the previous list request.
filter	string A filter expression that filters resources listed in the response. The expression must specify: The field name. Currently you can only use filtering with the Catalog.name field. An `=` operator. The value in double quotes (`"`). Must be 1-63 characters long and match the regular expression `[a-zA-Z0-9_-]+`.

ListCatalogsResponse

{
  "catalogs": [
    {
      "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>"
    }
  ],
  "next_page_token": "string"
}

Field

Description

catalogs[]

Catalog

List of Trino Catalog resources.

next_page_token

string

This token allows you to get the next page of results for list requests. If the number of results
is larger than ListCatalogsRequest.page_size, use the next_page_token as the value
for the ListCatalogsRequest.page_token parameter in the next list request. Each subsequent
list request will have its own next_page_token to continue paging through the results.

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 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	HiveConnector Hive connector configuration. Includes only one of the fields `hive`, `iceberg`, `delta_lake`, `postgresql`, `clickhouse`, `tpch`, `tpcds`, `oracle`, `sqlserver`, `hudi`.
iceberg	IcebergConnector Iceberg connector configuration. Includes only one of the fields `hive`, `iceberg`, `delta_lake`, `postgresql`, `clickhouse`, `tpch`, `tpcds`, `oracle`, `sqlserver`, `hudi`.
delta_lake	DeltaLakeConnector Delta Lake connector configuration. Includes only one of the fields `hive`, `iceberg`, `delta_lake`, `postgresql`, `clickhouse`, `tpch`, `tpcds`, `oracle`, `sqlserver`, `hudi`.
postgresql	PostgresqlConnector PostgreSQL connector configuration. Includes only one of the fields `hive`, `iceberg`, `delta_lake`, `postgresql`, `clickhouse`, `tpch`, `tpcds`, `oracle`, `sqlserver`, `hudi`.
clickhouse	ClickhouseConnector ClickHouse connector configuration. Includes only one of the fields `hive`, `iceberg`, `delta_lake`, `postgresql`, `clickhouse`, `tpch`, `tpcds`, `oracle`, `sqlserver`, `hudi`.
tpch	TPCHConnector TPC-H connector for synthetic benchmarking. Includes only one of the fields `hive`, `iceberg`, `delta_lake`, `postgresql`, `clickhouse`, `tpch`, `tpcds`, `oracle`, `sqlserver`, `hudi`.
tpcds	TPCDSConnector TPC-DS connector for synthetic benchmarking. Includes only one of the fields `hive`, `iceberg`, `delta_lake`, `postgresql`, `clickhouse`, `tpch`, `tpcds`, `oracle`, `sqlserver`, `hudi`.
oracle	OracleConnector Oracle connector configuration for connecting to Oracle Database instances. Includes only one of the fields `hive`, `iceberg`, `delta_lake`, `postgresql`, `clickhouse`, `tpch`, `tpcds`, `oracle`, `sqlserver`, `hudi`.
sqlserver	SQLServerConnector SQLServer connector configuration for connecting to SQLServer Database instances. Includes only one of the fields `hive`, `iceberg`, `delta_lake`, `postgresql`, `clickhouse`, `tpch`, `tpcds`, `oracle`, `sqlserver`, `hudi`.
hudi	HudiConnector Hudi connector configuration. Includes only one of the fields `hive`, `iceberg`, `delta_lake`, `postgresql`, `clickhouse`, `tpch`, `tpcds`, `oracle`, `sqlserver`, `hudi`.

HiveConnector

Field	Description
metastore	Metastore Required field. Metastore configuration.
filesystem	FileSystem Required field. File system configuration.
additional_properties	object (map<string, string>) Additional properties.

Metastore

Metastore configuration.

Field

Description

hive

HiveMetastore

Includes only one of the fields hive.

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 uri.

FileSystem

Configuration of file system used by a connector.

Field

Description

S3FileSystem

Includes only one of the fields s3, external_s3.

external_s3

ExternalS3FileSystem

Includes only one of the fields s3, external_s3.

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	Metastore Required field. Metastore configuration.
filesystem	FileSystem Required field. File system configuration.
additional_properties	object (map<string, string>) Additional properties.

DeltaLakeConnector

Field	Description
metastore	Metastore Required field. Metastore configuration.
filesystem	FileSystem Required field. File system configuration.
additional_properties	object (map<string, string>) Additional properties.

PostgresqlConnector

Field

Description

connection

PostgresqlConnection

Connection configuration.

additional_properties

object (map<string, string>)

Additional properties.

PostgresqlConnection

Field

Description

on_premise

OnPremise

Includes only one of the fields on_premise, connection_manager.

connection_manager

ConnectionManager

Includes only one of the fields on_premise, connection_manager.

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

ClickhouseConnection

Connection configuration.

additional_properties

object (map<string, string>)

Additional properties.

ClickhouseConnection

Field

Description

on_premise

OnPremise

Includes only one of the fields on_premise, connection_manager.

connection_manager

ConnectionManager

Includes only one of the fields on_premise, connection_manager.

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

OracleConnection

Connection configuration.

additional_properties

object (map<string, string>)

Additional properties.

OracleConnection

Field

Description

on_premise

OnPremise

Includes only one of the fields on_premise.

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

SQLServerConnection

Connection configuration.

additional_properties

object (map<string, string>)

Additional properties.

SQLServerConnection

Field

Description

on_premise

OnPremise

Includes only one of the fields on_premise.

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	Metastore Required field. Metastore configuration.
filesystem	FileSystem Required field. File system configuration.
additional_properties	object (map<string, string>) Additional properties.

Managed Service for Trino API, gRPC: CatalogService.List

gRPC requestgRPC request

ListCatalogsRequestListCatalogsRequest

ListCatalogsResponseListCatalogsResponse

CatalogCatalog

ConnectorConnector

HiveConnectorHiveConnector

MetastoreMetastore

HiveMetastoreHiveMetastore

FileSystemFileSystem

S3FileSystemS3FileSystem

ExternalS3FileSystemExternalS3FileSystem

IcebergConnectorIcebergConnector

DeltaLakeConnectorDeltaLakeConnector

PostgresqlConnectorPostgresqlConnector

PostgresqlConnectionPostgresqlConnection

OnPremiseOnPremise

ConnectionManagerConnectionManager

ClickhouseConnectorClickhouseConnector

ClickhouseConnectionClickhouseConnection

OnPremiseOnPremise

ConnectionManagerConnectionManager

TPCHConnectorTPCHConnector

TPCDSConnectorTPCDSConnector

OracleConnectorOracleConnector

OracleConnectionOracleConnection

OnPremiseOnPremise

SQLServerConnectorSQLServerConnector

SQLServerConnectionSQLServerConnection

OnPremiseOnPremise

HudiConnectorHudiConnector

Была ли статья полезна?

gRPC request

ListCatalogsRequest

ListCatalogsResponse

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