kinetica.AlterTableMetadataRequest Class Reference

A set of parameters for /alter/table/metadata. More...

Inheritance diagram for kinetica.AlterTableMetadataRequest:

Collaboration diagram for kinetica.AlterTableMetadataRequest:

Public Member Functions
	AlterTableMetadataRequest ()
	Constructs an AlterTableMetadataRequest object with default parameters. More...
	AlterTableMetadataRequest (IList< string > table_names, IDictionary< string, string > metadata_map, IDictionary< string, string > options=null)
	Constructs an AlterTableMetadataRequest 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 [get, set]
	Names of the tables whose metadata will be updated. More...
IDictionary< string, string >	metadata_map = new List<string>() [get, set]
	A map which contains the metadata of the tables that are to be updated. 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 /alter/table/metadata.

Updates (adds or changes) metadata for tables. The metadata key and values must both be strings. This is an easy way to annotate whole tables rather than single records within tables. Some examples of metadata are owner of the table, table creation timestamp etc.

Definition at line 21 of file AlterTableMetadata.cs.

Constructor & Destructor Documentation

kinetica.AlterTableMetadataRequest.AlterTableMetadataRequest ( )

inline

Constructs an AlterTableMetadataRequest object with default parameters.

Definition at line 42 of file AlterTableMetadata.cs.

kinetica.AlterTableMetadataRequest.AlterTableMetadataRequest ( IList< string >  table_names, IDictionary< string, string >  metadata_map, IDictionary< string, string >  options = null  )

inline

Constructs an AlterTableMetadataRequest object with the specified parameters.

Parameters

table_names	Names of the tables whose metadata will be updated. All specified tables must exist, or an error will be returned.
metadata_map	A map which contains the metadata of the tables that are to be updated. Note that only one map is provided for all the tables; so the change will be applied to every table. If the provided map is empty, then all existing metadata for the table(s) will be cleared.
options	Optional parameters.

Definition at line 57 of file AlterTableMetadata.cs.

Property Documentation

IDictionary<string, string> kinetica.AlterTableMetadataRequest.metadata_map = new List<string>()

getset

A map which contains the metadata of the tables that are to be updated.

Note that only one map is provided for all the tables; so the change will be applied to every table. If the provided map is empty, then all existing metadata for the table(s) will be cleared.

Definition at line 34 of file AlterTableMetadata.cs.

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

getset

Optional parameters.

Definition at line 37 of file AlterTableMetadata.cs.

IList<string> kinetica.AlterTableMetadataRequest.table_names

getset

Names of the tables whose metadata will be updated.

All specified tables must exist, or an error will be returned.

Definition at line 27 of file AlterTableMetadata.cs.

---

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

• Kinetica/Protocol/AlterTableMetadata.cs