/create/catalog

URL: https://<aws.fqdn>/<aws.cluster.name>/gpudb-0/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

NameTypeDescription
namestringName of the catalog to be created.
table_formatstringTable format (iceberg, hudi, deltalake).
locationstringLocation of the catalog in 'http[s]://[server[:port]]]' format.
typestringType of the catalog (REST (unity, polaris, tabular), nessie, hive, glue).
credentialstringName of the credential object to be used in catalog.
datasourcestringPassword for the remote system user; may be an empty string.
optionsmap of string to strings

Optional parameters.

The default value is an empty map ( {} ).

Supported Parameters (keys)Parameter Description
access_delegation

Use access delegation for object store.

The default value is datasource_credentials.

The supported values are:

  • datasource_credentials
  • vended_credentials
skip_validation

Bypass validation of connection to remote source.

The default value is false.

The supported values are:

  • true
  • false

Output Parameter Description

The Kinetica 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:

NameTypeDescription
statusString'OK' or 'ERROR'
messageStringEmpty if success or an error message
data_typeString'create_catalog_response' or 'none' in case of an error
dataStringEmpty string
data_strJSON or String

This embedded JSON represents the result of the /create/catalog endpoint:

NameTypeDescription
namestringValue of input parameter name.
infomap of string to stringsAdditional information.

Empty string in case of an error.