kinetica.ClearTableRequest Class Reference

A set of parameters for Kinetica.clearTable(string,string,IDictionary{string, string}). More...

Inheritance diagram for kinetica.ClearTableRequest:

Collaboration diagram for kinetica.ClearTableRequest:

Classes
struct	Options
	Optional parameters. More...

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. 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 Kinetica.clearTable(string,string,IDictionary{string, string}).

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 22 of file ClearTable.cs.

Constructor & Destructor Documentation

kinetica.ClearTableRequest.ClearTableRequest ( )

inline

Constructs a ClearTableRequest object with default parameters.

Definition at line 120 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, though this behavior is be prevented by default via gpudb.conf parameter 'disable_clear_all'. The default value is ''.
authorization	No longer used. User can pass an empty string. The default value is ''.
options	Optional parameters. NO_ERROR_IF_NOT_EXISTS: If true and if the table specified in does not exist no error is returned. If false and if the table specified in does not exist then an error is returned. Supported values: TRUE FALSE The default value is FALSE. The default value is an empty Dictionary.

Definition at line 158 of file ClearTable.cs.

Property Documentation

string kinetica.ClearTableRequest.authorization = ""

getset

No longer used.

User can pass an empty string. The default value is ''.

Definition at line 87 of file ClearTable.cs.

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

getset

Optional parameters.

• NO_ERROR_IF_NOT_EXISTS: If true and if the table specified in does not exist no error is returned. If false and if the table specified in does not exist then an error is returned. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.

The default value is an empty Dictionary.

Definition at line 115 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, though this behavior is be prevented by default via gpudb.conf parameter 'disable_clear_all'. The default value is ''.

Definition at line 83 of file ClearTable.cs.

---

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

• Kinetica/Protocol/ClearTable.cs