URL: http://<db.host>:<db.port>/create/catalog
Creates a catalog, which contains the location and connection information for a deltalake catalog that is external to the database.
Input Parameter Description
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
| name | string | Name of the catalog to be created. | ||||||
| table_format | string | Table format (iceberg, hudi, deltalake) | ||||||
| location | string | Location of the catalog in 'http[s]://[server[:port]]]' format. | ||||||
| type | string | Type of the catalog (REST (unity, polaris, tabular), nessie, hive, glue) | ||||||
| credential | string | Name of the credential object to be used in catalog | ||||||
| datasource | string | Password for the remote system user; may be an empty string | ||||||
| options | map of string to strings | Optional parameters. The default value is an empty map ( {} ).
|
Output Parameter Description
The GPUdb server embeds the endpoint response inside a standard response structure which contains status information and the actual response to the query. Here is a description of the various fields of the wrapper:
| Name | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| status | String | 'OK' or 'ERROR' | |||||||||
| message | String | Empty if success or an error message | |||||||||
| data_type | String | 'create_catalog_response' or 'none' in case of an error | |||||||||
| data | String | Empty string | |||||||||
| data_str | JSON or String | This embedded JSON represents the result of the /create/catalog endpoint:
Empty string in case of an error. |