Managed Service for Trino API, REST: Catalog.Create
- HTTP request
- Path parameters
- Body parameters
- CatalogSpec
- Connector
- HiveConnector
- Metastore
- HiveMetastore
- FileSystem
- ExternalS3FileSystem
- IcebergConnector
- DeltaLakeConnector
- PostgresqlConnector
- PostgresqlConnection
- OnPremise
- ConnectionManager
- ClickhouseConnector
- ClickhouseConnection
- OnPremise
- ConnectionManager
- TPCHConnector
- TPCDSConnector
- OracleConnector
- OracleConnection
- OnPremise
- SQLServerConnector
- SQLServerConnection
- OnPremise
- HudiConnector
- Response
- CreateCatalogMetadata
- Status
- Catalog
- Connector
- HiveConnector
- Metastore
- HiveMetastore
- FileSystem
- ExternalS3FileSystem
- IcebergConnector
- DeltaLakeConnector
- PostgresqlConnector
- PostgresqlConnection
- OnPremise
- ConnectionManager
- ClickhouseConnector
- ClickhouseConnection
- OnPremise
- ConnectionManager
- TPCHConnector
- TPCDSConnector
- OracleConnector
- OracleConnection
- OnPremise
- SQLServerConnector
- SQLServerConnection
- OnPremise
- HudiConnector
Creates a new Trino Catalog.
HTTP request
POST https://trino.api.cloud.yandex.net/managed-trino/v1/clusters/{clusterId}/catalogs
Path parameters
|
Field |
Description |
|
clusterId |
string Required field. ID of the Trino Cluster where the catalog should be created. |
Body parameters
{
"catalog": {
"name": "string",
"connector": {
// Includes only one of the fields `hive`, `iceberg`, `deltaLake`, `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`, `externalS3`
"s3": "object",
"externalS3": {
"awsAccessKey": "string",
"awsSecretKey": "string",
"awsEndpoint": "string",
"awsRegion": "string"
}
// end of the list of possible fields
},
"additionalProperties": "object"
},
"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`, `externalS3`
"s3": "object",
"externalS3": {
"awsAccessKey": "string",
"awsSecretKey": "string",
"awsEndpoint": "string",
"awsRegion": "string"
}
// end of the list of possible fields
},
"additionalProperties": "object"
},
"deltaLake": {
"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`, `externalS3`
"s3": "object",
"externalS3": {
"awsAccessKey": "string",
"awsSecretKey": "string",
"awsEndpoint": "string",
"awsRegion": "string"
}
// end of the list of possible fields
},
"additionalProperties": "object"
},
"postgresql": {
"connection": {
// Includes only one of the fields `onPremise`, `connectionManager`
"onPremise": {
"connectionUrl": "string",
"userName": "string",
"password": "string"
},
"connectionManager": {
"connectionId": "string",
"database": "string",
"connectionProperties": "object"
}
// end of the list of possible fields
},
"additionalProperties": "object"
},
"clickhouse": {
"connection": {
// Includes only one of the fields `onPremise`, `connectionManager`
"onPremise": {
"connectionUrl": "string",
"userName": "string",
"password": "string"
},
"connectionManager": {
"connectionId": "string",
"database": "string",
"connectionProperties": "object"
}
// end of the list of possible fields
},
"additionalProperties": "object"
},
"tpch": {
"additionalProperties": "object"
},
"tpcds": {
"additionalProperties": "object"
},
"oracle": {
"connection": {
// Includes only one of the fields `onPremise`
"onPremise": {
"connectionUrl": "string",
"userName": "string",
"password": "string"
}
// end of the list of possible fields
},
"additionalProperties": "object"
},
"sqlserver": {
"connection": {
// Includes only one of the fields `onPremise`
"onPremise": {
"connectionUrl": "string",
"userName": "string",
"password": "string"
}
// end of the list of possible fields
},
"additionalProperties": "object"
},
"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`, `externalS3`
"s3": "object",
"externalS3": {
"awsAccessKey": "string",
"awsSecretKey": "string",
"awsEndpoint": "string",
"awsRegion": "string"
}
// end of the list of possible fields
},
"additionalProperties": "object"
}
// end of the list of possible fields
},
"description": "string",
"labels": "object"
}
}
|
Field |
Description |
|
catalog |
Required field. Specification of the catalog to be created. |
CatalogSpec
CatalogSpec defines the desired state of a new catalog.
|
Field |
Description |
|
name |
string Required field. Name of the catalog. |
|
connector |
Required field. 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 |
|
deltaLake |
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. |
|
additionalProperties |
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 |
object Includes only one of the fields |
|
externalS3 |
Includes only one of the fields |
ExternalS3FileSystem
Describes External S3 compatible file system.
|
Field |
Description |
|
awsAccessKey |
string Required field. |
|
awsSecretKey |
string Required field. |
|
awsEndpoint |
string Required field. |
|
awsRegion |
string Required field. |
IcebergConnector
|
Field |
Description |
|
metastore |
Required field. Metastore configuration. |
|
filesystem |
Required field. File system configuration. |
|
additionalProperties |
object (map<string, string>) Additional properties. |
DeltaLakeConnector
|
Field |
Description |
|
metastore |
Required field. Metastore configuration. |
|
filesystem |
Required field. File system configuration. |
|
additionalProperties |
object (map<string, string>) Additional properties. |
PostgresqlConnector
|
Field |
Description |
|
connection |
Connection configuration. |
|
additionalProperties |
object (map<string, string>) Additional properties. |
PostgresqlConnection
|
Field |
Description |
|
onPremise |
Includes only one of the fields |
|
connectionManager |
Includes only one of the fields |
OnPremise
|
Field |
Description |
|
connectionUrl |
string Required field. Connection to the Postgresql. |
|
userName |
string Required field. Name of the Postgresql user. |
|
password |
string Required field. Password of the Postgresql user. |
ConnectionManager
|
Field |
Description |
|
connectionId |
string Required field. Connection ID. |
|
database |
string Required field. Database. |
|
connectionProperties |
object (map<string, string>) Additional connection properties. |
ClickhouseConnector
|
Field |
Description |
|
connection |
Connection configuration. |
|
additionalProperties |
object (map<string, string>) Additional properties. |
ClickhouseConnection
|
Field |
Description |
|
onPremise |
Includes only one of the fields |
|
connectionManager |
Includes only one of the fields |
OnPremise
|
Field |
Description |
|
connectionUrl |
string Required field. Connection to the Clickhouse. |
|
userName |
string Required field. Name of the Clickhouse user. |
|
password |
string Required field. Password of the Clickhouse user. |
ConnectionManager
|
Field |
Description |
|
connectionId |
string Required field. Connection ID. |
|
database |
string Required field. Database. |
|
connectionProperties |
object (map<string, string>) Additional connection properties. |
TPCHConnector
|
Field |
Description |
|
additionalProperties |
object (map<string, string>) Additional properties. |
TPCDSConnector
|
Field |
Description |
|
additionalProperties |
object (map<string, string>) Additional properties. |
OracleConnector
|
Field |
Description |
|
connection |
Connection configuration. |
|
additionalProperties |
object (map<string, string>) Additional properties. |
OracleConnection
|
Field |
Description |
|
onPremise |
Includes only one of the fields |
OnPremise
|
Field |
Description |
|
connectionUrl |
string Required field. Connection to the Oracle. |
|
userName |
string Required field. Name of the Oracle user. |
|
password |
string Required field. Password of the Oracle user. |
SQLServerConnector
|
Field |
Description |
|
connection |
Connection configuration. |
|
additionalProperties |
object (map<string, string>) Additional properties. |
SQLServerConnection
|
Field |
Description |
|
onPremise |
Includes only one of the fields |
OnPremise
|
Field |
Description |
|
connectionUrl |
string Required field. Connection to the SQLServer. |
|
userName |
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. |
|
additionalProperties |
object (map<string, string>) Additional properties. |
Response
HTTP Code: 200 - OK
{
"id": "string",
"description": "string",
"createdAt": "string",
"createdBy": "string",
"modifiedAt": "string",
"done": "boolean",
"metadata": {
"clusterId": "string",
"catalogId": "string"
},
// Includes only one of the fields `error`, `response`
"error": {
"code": "integer",
"message": "string",
"details": [
"object"
]
},
"response": {
"id": "string",
"name": "string",
"connector": {
// Includes only one of the fields `hive`, `iceberg`, `deltaLake`, `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`, `externalS3`
"s3": "object",
"externalS3": {
"awsAccessKey": "string",
"awsSecretKey": "string",
"awsEndpoint": "string",
"awsRegion": "string"
}
// end of the list of possible fields
},
"additionalProperties": "object"
},
"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`, `externalS3`
"s3": "object",
"externalS3": {
"awsAccessKey": "string",
"awsSecretKey": "string",
"awsEndpoint": "string",
"awsRegion": "string"
}
// end of the list of possible fields
},
"additionalProperties": "object"
},
"deltaLake": {
"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`, `externalS3`
"s3": "object",
"externalS3": {
"awsAccessKey": "string",
"awsSecretKey": "string",
"awsEndpoint": "string",
"awsRegion": "string"
}
// end of the list of possible fields
},
"additionalProperties": "object"
},
"postgresql": {
"connection": {
// Includes only one of the fields `onPremise`, `connectionManager`
"onPremise": {
"connectionUrl": "string",
"userName": "string",
"password": "string"
},
"connectionManager": {
"connectionId": "string",
"database": "string",
"connectionProperties": "object"
}
// end of the list of possible fields
},
"additionalProperties": "object"
},
"clickhouse": {
"connection": {
// Includes only one of the fields `onPremise`, `connectionManager`
"onPremise": {
"connectionUrl": "string",
"userName": "string",
"password": "string"
},
"connectionManager": {
"connectionId": "string",
"database": "string",
"connectionProperties": "object"
}
// end of the list of possible fields
},
"additionalProperties": "object"
},
"tpch": {
"additionalProperties": "object"
},
"tpcds": {
"additionalProperties": "object"
},
"oracle": {
"connection": {
// Includes only one of the fields `onPremise`
"onPremise": {
"connectionUrl": "string",
"userName": "string",
"password": "string"
}
// end of the list of possible fields
},
"additionalProperties": "object"
},
"sqlserver": {
"connection": {
// Includes only one of the fields `onPremise`
"onPremise": {
"connectionUrl": "string",
"userName": "string",
"password": "string"
}
// end of the list of possible fields
},
"additionalProperties": "object"
},
"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`, `externalS3`
"s3": "object",
"externalS3": {
"awsAccessKey": "string",
"awsSecretKey": "string",
"awsEndpoint": "string",
"awsRegion": "string"
}
// end of the list of possible fields
},
"additionalProperties": "object"
}
// end of the list of possible fields
},
"description": "string",
"labels": "object"
}
// 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. |
|
createdAt |
string (date-time) Creation timestamp. String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the |
|
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 text format. The range of possible values is from To work with values in this field, use the APIs described in the |
|
done |
boolean 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. |
CreateCatalogMetadata
|
Field |
Description |
|
clusterId |
string ID of the Trino cluster where a catalog is being created. |
|
catalogId |
string ID of the catalog that is being created. |
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. |
|
message |
string An error message. |
|
details[] |
object A list of messages that carry the error details. |
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 |
|
deltaLake |
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. |
|
additionalProperties |
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 |
object Includes only one of the fields |
|
externalS3 |
Includes only one of the fields |
ExternalS3FileSystem
Describes External S3 compatible file system.
|
Field |
Description |
|
awsAccessKey |
string Required field. |
|
awsSecretKey |
string Required field. |
|
awsEndpoint |
string Required field. |
|
awsRegion |
string Required field. |
IcebergConnector
|
Field |
Description |
|
metastore |
Required field. Metastore configuration. |
|
filesystem |
Required field. File system configuration. |
|
additionalProperties |
object (map<string, string>) Additional properties. |
DeltaLakeConnector
|
Field |
Description |
|
metastore |
Required field. Metastore configuration. |
|
filesystem |
Required field. File system configuration. |
|
additionalProperties |
object (map<string, string>) Additional properties. |
PostgresqlConnector
|
Field |
Description |
|
connection |
Connection configuration. |
|
additionalProperties |
object (map<string, string>) Additional properties. |
PostgresqlConnection
|
Field |
Description |
|
onPremise |
Includes only one of the fields |
|
connectionManager |
Includes only one of the fields |
OnPremise
|
Field |
Description |
|
connectionUrl |
string Required field. Connection to the Postgresql. |
|
userName |
string Required field. Name of the Postgresql user. |
|
password |
string Required field. Password of the Postgresql user. |
ConnectionManager
|
Field |
Description |
|
connectionId |
string Required field. Connection ID. |
|
database |
string Required field. Database. |
|
connectionProperties |
object (map<string, string>) Additional connection properties. |
ClickhouseConnector
|
Field |
Description |
|
connection |
Connection configuration. |
|
additionalProperties |
object (map<string, string>) Additional properties. |
ClickhouseConnection
|
Field |
Description |
|
onPremise |
Includes only one of the fields |
|
connectionManager |
Includes only one of the fields |
OnPremise
|
Field |
Description |
|
connectionUrl |
string Required field. Connection to the Clickhouse. |
|
userName |
string Required field. Name of the Clickhouse user. |
|
password |
string Required field. Password of the Clickhouse user. |
ConnectionManager
|
Field |
Description |
|
connectionId |
string Required field. Connection ID. |
|
database |
string Required field. Database. |
|
connectionProperties |
object (map<string, string>) Additional connection properties. |
TPCHConnector
|
Field |
Description |
|
additionalProperties |
object (map<string, string>) Additional properties. |
TPCDSConnector
|
Field |
Description |
|
additionalProperties |
object (map<string, string>) Additional properties. |
OracleConnector
|
Field |
Description |
|
connection |
Connection configuration. |
|
additionalProperties |
object (map<string, string>) Additional properties. |
OracleConnection
|
Field |
Description |
|
onPremise |
Includes only one of the fields |
OnPremise
|
Field |
Description |
|
connectionUrl |
string Required field. Connection to the Oracle. |
|
userName |
string Required field. Name of the Oracle user. |
|
password |
string Required field. Password of the Oracle user. |
SQLServerConnector
|
Field |
Description |
|
connection |
Connection configuration. |
|
additionalProperties |
object (map<string, string>) Additional properties. |
SQLServerConnection
|
Field |
Description |
|
onPremise |
Includes only one of the fields |
OnPremise
|
Field |
Description |
|
connectionUrl |
string Required field. Connection to the SQLServer. |
|
userName |
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. |
|
additionalProperties |
object (map<string, string>) Additional properties. |