Kinetica C# API  Version 7.1.10.0
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Pages
kinetica.ExportRecordsToTableRequest Class Reference

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

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

Classes

struct  Options
 Optional parameters. More...
 

Public Member Functions

 ExportRecordsToTableRequest ()
 Constructs an ExportRecordsToTableRequest object with default parameters. More...
 
 ExportRecordsToTableRequest (string table_name, string remote_query=null, IDictionary< string, string > options=null)
 Constructs an ExportRecordsToTableRequest 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 from which the data will be exported to remote database, in [schema_name. More...
 
string remote_query [get, set]
 Parameterized insert query to export gpudb table data into remote database. 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.exportRecordsToTable(string,string,IDictionary{string, string}).


Exports records from source table to the specified target table in an external database

Definition at line 20 of file ExportRecordsToTable.cs.

Constructor & Destructor Documentation

kinetica.ExportRecordsToTableRequest.ExportRecordsToTableRequest ( )
inline

Constructs an ExportRecordsToTableRequest object with default parameters.

Definition at line 256 of file ExportRecordsToTable.cs.

kinetica.ExportRecordsToTableRequest.ExportRecordsToTableRequest ( string  table_name,
string  remote_query = null,
IDictionary< string, string >  options = null 
)
inline

Constructs an ExportRecordsToTableRequest object with the specified parameters.

Parameters
table_nameName of the table from which the data will be exported to remote database, in [schema_name.]table_name format, using standard name resolution rules.
remote_queryParameterized insert query to export gpudb table data into remote database. The default value is ''.
optionsOptional parameters.
  • BATCH_SIZE: Batch size, which determines how many rows to export per round trip. The default value is '200000'.
  • DATASINK_NAME: Name of an existing external data sink to which table name specified in will be exported
  • JDBC_SESSION_INIT_STATEMENT: Executes the statement per each jdbc session before doing actual load. The default value is ''.
  • JDBC_CONNECTION_INIT_STATEMENT: Executes the statement once before doing actual load. The default value is ''.
  • REMOTE_TABLE: Name of the target table to which source table is exported. When this option is specified remote_query cannot be specified. The default value is ''.
  • USE_ST_GEOMFROM_CASTS: Wraps parametrized variables with st_geomfromtext or st_geomfromwkb based on source column type Supported values: The default value is FALSE.
  • USE_INDEXED_PARAMETERS: Uses $n style syntax when generating insert query for remote_table option Supported values: The default value is TRUE.
The default value is an empty Dictionary.

Definition at line 346 of file ExportRecordsToTable.cs.

Property Documentation

IDictionary<string, string> kinetica.ExportRecordsToTableRequest.options = ""
getset

Optional parameters.

  • BATCH_SIZE: Batch size, which determines how many rows to export per round trip. The default value is '200000'.
  • DATASINK_NAME: Name of an existing external data sink to which table name specified in will be exported
  • JDBC_SESSION_INIT_STATEMENT: Executes the statement per each jdbc session before doing actual load. The default value is ''.
  • JDBC_CONNECTION_INIT_STATEMENT: Executes the statement once before doing actual load. The default value is ''.
  • REMOTE_TABLE: Name of the target table to which source table is exported. When this option is specified remote_query cannot be specified. The default value is ''.
  • USE_ST_GEOMFROM_CASTS: Wraps parametrized variables with st_geomfromtext or st_geomfromwkb based on source column type Supported values: The default value is FALSE.
  • USE_INDEXED_PARAMETERS: Uses $n style syntax when generating insert query for remote_table option Supported values: The default value is TRUE.

The default value is an empty Dictionary.

Definition at line 251 of file ExportRecordsToTable.cs.

string kinetica.ExportRecordsToTableRequest.remote_query
getset

Parameterized insert query to export gpudb table data into remote database.

The default value is ''.

Definition at line 173 of file ExportRecordsToTable.cs.

string kinetica.ExportRecordsToTableRequest.table_name
getset

Name of the table from which the data will be exported to remote database, in [schema_name.

]table_name format, using standard name resolution rules.

Definition at line 169 of file ExportRecordsToTable.cs.


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