Kinetica   C#   API  Version 7.2.3.0
kinetica.ShowTableMetadataRequest Class Reference

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

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

Public Member Functions

 ShowTableMetadataRequest ()
 Constructs a ShowTableMetadataRequest object with default parameters. More...
 
 ShowTableMetadataRequest (IList< string > table_names, IDictionary< string, string > options=null)
 Constructs a ShowTableMetadataRequest 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...
 

Properties

IList< string > table_names = new List<string>() [get, set]
 Names of tables whose metadata will be fetched, in [schema_name. 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...
 

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...
 

Detailed Description

A set of parameters for Kinetica.showTableMetadata.

Retrieves the user provided metadata for the specified tables.

Definition at line 16 of file ShowTableMetadata.cs.

Constructor & Destructor Documentation

◆ ShowTableMetadataRequest() [1/2]

kinetica.ShowTableMetadataRequest.ShowTableMetadataRequest ( )
inline

Constructs a ShowTableMetadataRequest object with default parameters.

Definition at line 33 of file ShowTableMetadata.cs.

◆ ShowTableMetadataRequest() [2/2]

kinetica.ShowTableMetadataRequest.ShowTableMetadataRequest ( IList< string >  table_names,
IDictionary< string, string >  options = null 
)
inline

Constructs a ShowTableMetadataRequest object with the specified parameters.

Parameters
table_namesNames of tables whose metadata will be fetched, in [schema_name.]table_name format, using standard name resolution rules. All provided tables must exist, or an error is returned.
optionsOptional parameters. The default value is an empty Dictionary.

Definition at line 45 of file ShowTableMetadata.cs.

Property Documentation

◆ options

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

Optional parameters.

The default value is an empty Dictionary.

Definition at line 29 of file ShowTableMetadata.cs.

◆ table_names

IList<string> kinetica.ShowTableMetadataRequest.table_names = new List<string>()
getset

Names of tables whose metadata will be fetched, in [schema_name.

]table_name format, using standard name resolution rules.

All provided tables must exist, or an error is returned.

Definition at line 24 of file ShowTableMetadata.cs.


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