kinetica.ClearTableRequest Class Reference

A set of parameters for /clear/table. More...

Inheritance diagram for kinetica.ClearTableRequest:

Collaboration diagram for kinetica.ClearTableRequest:

Public Member Functions
	ClearTableRequest ()
	Constructs a ClearTableRequest object with default parameters. More...
	ClearTableRequest (string table_name=null, string authorization=null, IDictionary< string, string > options=null)
	Constructs a ClearTableRequest 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
string	table_name [get, set]
	Name of the table to be cleared. More...
string	authorization = "" [get, set]
	No longer used. User can pass an empty string. More...
IDictionary< string, string >	options = "" [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 /clear/table.

Clears (drops) one or all tables in the database cluster. The operation is synchronous meaning that the table will be cleared before the function returns. The response payload returns the status of the operation along with the name of the table that was cleared.

Definition at line 20 of file ClearTable.cs.

Constructor & Destructor Documentation

kinetica.ClearTableRequest.ClearTableRequest ( )

inline

Constructs a ClearTableRequest object with default parameters.

Definition at line 36 of file ClearTable.cs.

kinetica.ClearTableRequest.ClearTableRequest ( string  table_name = null, string  authorization = null, IDictionary< string, string >  options = null  )

inline

Constructs a ClearTableRequest object with the specified parameters.

Parameters

table_name	Name of the table to be cleared. Must be an existing table. Empty string clears all available tables.
authorization	No longer used. User can pass an empty string.
options	Optional parameters.

Definition at line 48 of file ClearTable.cs.

Property Documentation

string kinetica.ClearTableRequest.authorization = ""

getset

No longer used. User can pass an empty string.

Definition at line 28 of file ClearTable.cs.

IDictionary<string, string> kinetica.ClearTableRequest.options = ""

getset

Optional parameters.

Definition at line 31 of file ClearTable.cs.

string kinetica.ClearTableRequest.table_name

getset

Name of the table to be cleared.

Must be an existing table. Empty string clears all available tables.

Definition at line 25 of file ClearTable.cs.

---

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

• Kinetica/Protocol/ClearTable.cs