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

Inheritance diagram for kinetica.ExportRecordsToTableRequest:

Collaboration diagram for kinetica.ExportRecordsToTableRequest:

Classes
struct	Options
	A set of string constants for the parameter options. 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...

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

	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 = new Dictionary<string, string>() `[get, set]`
	Optional parameters. More...

Properties inherited from kinetica.KineticaData
Schema	Schema `[get]`
	Avro Schema for this class More...

Properties inherited from Avro.Specific.ISpecificRecord
Schema	Schema `[get]`

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

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.

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

Definition at line 16 of file ExportRecordsToTable.cs.

Constructor & Destructor Documentation

◆ ExportRecordsToTableRequest() [1/4]

kinetica.ExportRecordsToTableRequest.ExportRecordsToTableRequest ( )

inline

Constructs an ExportRecordsToTableRequest object with default parameters.

Definition at line 175 of file ExportRecordsToTable.cs.

◆ ExportRecordsToTableRequest() [2/4]

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_name	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.
remote_query	Parameterized insert query to export gpudb table data into remote database. The default value is ''.
options	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 table_name 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 parameterized variables with st_geomfromtext or st_geomfromwkb based on source column type. Supported values: TRUE FALSE The default value is FALSE. USE_INDEXED_PARAMETERS: Uses $n style syntax when generating insert query for remote_table option. Supported values: TRUE FALSE The default value is FALSE. The default value is an empty Dictionary.

Definition at line 265 of file ExportRecordsToTable.cs.

◆ ExportRecordsToTableRequest() [3/4]

kinetica.ExportRecordsToTableRequest.ExportRecordsToTableRequest ( )

inline

Constructs an ExportRecordsToTableRequest object with default parameters.

Definition at line 175 of file ExportRecordsToTable.cs.

◆ ExportRecordsToTableRequest() [4/4]

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_name	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.
remote_query	Parameterized insert query to export gpudb table data into remote database. The default value is ''.
options	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 table_name 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 parameterized variables with st_geomfromtext or st_geomfromwkb based on source column type. Supported values: TRUE FALSE The default value is FALSE. USE_INDEXED_PARAMETERS: Uses $n style syntax when generating insert query for remote_table option. Supported values: TRUE FALSE The default value is FALSE. The default value is an empty Dictionary.

Definition at line 265 of file ExportRecordsToTable.cs.

Property Documentation

◆ options

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

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 table_name 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 parameterized variables with st_geomfromtext or st_geomfromwkb based on source column type. Supported values:
- TRUE
- FALSE
The default value is FALSE.
USE_INDEXED_PARAMETERS: Uses $n style syntax when generating insert query for remote_table option. Supported values:
- TRUE
- FALSE
The default value is FALSE.

The default value is an empty Dictionary.

Definition at line 171 of file ExportRecordsToTable.cs.

◆ remote_query

string kinetica.ExportRecordsToTableRequest.remote_query = ""

getset

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

The default value is ''.

Definition at line 92 of file ExportRecordsToTable.cs.

◆ table_name

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 87 of file ExportRecordsToTable.cs.

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

_build/public-os_ubuntu24.04-arch_amd64-cc_gcc_13.3.0/install/Kinetica/Protocol/ExportRecordsToTable.cs

Classes

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ExportRecordsToTableRequest() [1/4]

◆ ExportRecordsToTableRequest() [2/4]

◆ ExportRecordsToTableRequest() [3/4]

◆ ExportRecordsToTableRequest() [4/4]

Property Documentation

◆ options

◆ remote_query

◆ table_name