Kinetica   C#   API  Version 7.2.3.0
kinetica.CreateCatalogRequest Class Reference

A set of parameters for Kinetica.createCatalog. More...

+ Inheritance diagram for kinetica.CreateCatalogRequest:
+ Collaboration diagram for kinetica.CreateCatalogRequest:

Classes

struct  Options
 A set of string constants for the parameter options. More...
 

Public Member Functions

 CreateCatalogRequest ()
 Constructs a CreateCatalogRequest object with default parameters. More...
 
 CreateCatalogRequest (string name, string table_format, string location, string type, string credential, string datasource, IDictionary< string, string > options=null)
 Constructs a CreateCatalogRequest object with the specified parameters. More...
 
- Public Member Functions inherited from kinetica.KineticaData
 KineticaData (KineticaType type)
 Constructor from Kinetica Type More...
 
 KineticaData (System.Type type=null)
 Default constructor, with optional System.Type More...
 
object Get (int fieldPos)
 Retrieve a specific property from this object More...
 
void Put (int fieldPos, object fieldValue)
 Write a specific property to this object More...
 
 KineticaData (KineticaType type)
 Constructor from Kinetica Type More...
 
 KineticaData (System.Type type=null)
 Default constructor, with optional System.Type More...
 
object Get (int fieldPos)
 Retrieve a specific property from this object More...
 
void Put (int fieldPos, object fieldValue)
 Write a specific property to this object More...
 

Properties

string name [get, set]
 Name of the catalog to be created. More...
 
string table_format [get, set]
 Table format (iceberg, hudi, deltalake) More...
 
string location [get, set]
 Location of the catalog in 'http[s]://[server[:port]]]' format. More...
 
string type [get, set]
 Type of the catalog (REST (unity, polaris, tabular), nessie, hive, glue) More...
 
string credential [get, set]
 Name of the credential object to be used in catalog More...
 
string datasource [get, set]
 Password for the remote system user; may be an empty string More...
 
IDictionary< string, string > options = new Dictionary<string, string>() [get, set]
 Optional parameters. More...
 
- Properties inherited from kinetica.KineticaData
Schema Schema [get]
 Avro Schema for this class More...
 
- Properties inherited from Avro.Specific.ISpecificRecord
Schema Schema [get]
 

Additional Inherited Members

- Static Public Member Functions inherited from kinetica.KineticaData
static ? RecordSchema SchemaFromType (System.Type t, KineticaType? ktype=null)
 Create an Avro Schema from a System.Type and a KineticaType. More...
 
static ? RecordSchema SchemaFromType (System.Type t, KineticaType? ktype=null)
 Create an Avro Schema from a System.Type and a KineticaType. More...
 

Detailed Description

A set of parameters for Kinetica.createCatalog.

Creates a catalog, which contains the location and connection information for a deltalake catalog that is external to the database.

Definition at line 17 of file CreateCatalog.cs.

Constructor & Destructor Documentation

◆ CreateCatalogRequest() [1/2]

kinetica.CreateCatalogRequest.CreateCatalogRequest ( )
inline

Constructs a CreateCatalogRequest object with default parameters.

Definition at line 135 of file CreateCatalog.cs.

◆ CreateCatalogRequest() [2/2]

kinetica.CreateCatalogRequest.CreateCatalogRequest ( string  name,
string  table_format,
string  location,
string  type,
string  credential,
string  datasource,
IDictionary< string, string >  options = null 
)
inline

Constructs a CreateCatalogRequest object with the specified parameters.

Parameters
nameName of the catalog to be created.
table_formatTable format (iceberg, hudi, deltalake)
locationLocation of the catalog in 'http[s]://[server[:port]]]' format.
typeType of the catalog (REST (unity, polaris, tabular), nessie, hive, glue)
credentialName of the credential object to be used in catalog
datasourcePassword for the remote system user; may be an empty string
optionsOptional parameters. The default value is an empty Dictionary.

Definition at line 196 of file CreateCatalog.cs.

Property Documentation

◆ credential

string kinetica.CreateCatalogRequest.credential
getset

Name of the credential object to be used in catalog

Definition at line 81 of file CreateCatalog.cs.

◆ datasource

string kinetica.CreateCatalogRequest.datasource
getset

Password for the remote system user; may be an empty string

Definition at line 85 of file CreateCatalog.cs.

◆ location

string kinetica.CreateCatalogRequest.location
getset

Location of the catalog in 'http[s]://[server[:port]]]' format.

Definition at line 73 of file CreateCatalog.cs.

◆ name

string kinetica.CreateCatalogRequest.name
getset

Name of the catalog to be created.

Definition at line 66 of file CreateCatalog.cs.

◆ options

IDictionary<string, string> kinetica.CreateCatalogRequest.options = new Dictionary<string, string>()
getset

Optional parameters.

The default value is an empty Dictionary.

Definition at line 131 of file CreateCatalog.cs.

◆ table_format

string kinetica.CreateCatalogRequest.table_format
getset

Table format (iceberg, hudi, deltalake)

Definition at line 69 of file CreateCatalog.cs.

◆ type

string kinetica.CreateCatalogRequest.type
getset

Type of the catalog (REST (unity, polaris, tabular), nessie, hive, glue)

Definition at line 77 of file CreateCatalog.cs.


The documentation for this class was generated from the following file: