A set of parameters for GPUdb::createCatalog. More…
#include <gpudb/protocol/create_catalog.h>
Public Member Functions | |
| CreateCatalogRequest () | |
| Constructs a CreateCatalogRequest object with default parameters. | |
| CreateCatalogRequest (const std::string &name_, const std::string &tableFormat_, const std::string &location_, const std::string &type_, const std::string &credential_, const std::string &datasource_, const std::map< std::string, std::string > &options_) | |
| Constructs a CreateCatalogRequest object with the specified parameters. | |
Public Attributes | |
| std::string | name |
| Name of the catalog to be created. | |
| std::string | tableFormat |
| Table format (iceberg, hudi, deltalake). | |
| std::string | location |
| Location of the catalog in ‘http[s]://[server[:port]]]’ format. | |
| std::string | type |
| Type of the catalog (REST (unity, polaris, tabular), nessie, hive, glue). | |
| std::string | credential |
| Name of the credential object to be used in catalog. | |
| std::string | datasource |
| Password for the remote system user; may be an empty string. | |
| std::map< std::string, std::string > | options |
| Optional parameters. | |
Detailed Description
A set of parameters for GPUdb::createCatalog.
Creates a catalog, which contains the location and connection information for a deltalake catalog that is external to the database.
Definition at line 19 of file create_catalog.h.
Constructor & Destructor Documentation
◆ CreateCatalogRequest() [1/2]
| inline |
Constructs a CreateCatalogRequest object with default parameters.
Definition at line 24 of file create_catalog.h.
◆ CreateCatalogRequest() [2/2]
| inline |
Constructs a CreateCatalogRequest object with the specified parameters.
| [in] | name_ | Name of the catalog to be created. |
| [in] | tableFormat_ | Table format (iceberg, hudi, deltalake). |
| [in] | location_ | Location of the catalog in ‘http[s]://[server[:port]]]’ format. |
| [in] | type_ | Type of the catalog (REST (unity, polaris, tabular), nessie, hive, glue). |
| [in] | credential_ | Name of the credential object to be used in catalog. |
| [in] | datasource_ | Password for the remote system user; may be an empty string. |
| [in] | options_ | Optional parameters.
|
Definition at line 88 of file create_catalog.h.
Member Data Documentation
◆ credential
| std::string gpudb::CreateCatalogRequest::credential |
Name of the credential object to be used in catalog.
Definition at line 124 of file create_catalog.h.
◆ datasource
| std::string gpudb::CreateCatalogRequest::datasource |
Password for the remote system user; may be an empty string.
Definition at line 129 of file create_catalog.h.
◆ location
| std::string gpudb::CreateCatalogRequest::location |
Location of the catalog in ‘http[s]://[server[:port]]]’ format.
Definition at line 112 of file create_catalog.h.
◆ name
| std::string gpudb::CreateCatalogRequest::name |
Name of the catalog to be created.
Definition at line 102 of file create_catalog.h.
◆ options
| std::map<std::string, std::string> gpudb::CreateCatalogRequest::options |
Optional parameters.
- create_catalog_access_delegation: Use access delegation for object store. Supported values:The default value is create_catalog_datasource_credentials.
- create_catalog_skip_validation: Bypass validation of connection to remote source. Supported values:The default value is create_catalog_false.
The default value is an empty map.
Definition at line 162 of file create_catalog.h.
◆ tableFormat
| std::string gpudb::CreateCatalogRequest::tableFormat |
Table format (iceberg, hudi, deltalake).
Definition at line 107 of file create_catalog.h.
◆ type
| std::string gpudb::CreateCatalogRequest::type |
Type of the catalog (REST (unity, polaris, tabular), nessie, hive, glue).
Definition at line 118 of file create_catalog.h.
The documentation for this struct was generated from the following file:
- gpudb/protocol/create_catalog.h