A set of parameters for Kinetica.exportRecordsToTable. More…
Inheritance diagram for kinetica.ExportRecordsToTableRequest:
[legend]
Collaboration diagram for kinetica.ExportRecordsToTableRequest:
[legend]
Classes | |
| struct | Options |
| A set of string constants for the parameter ExportRecordsToTableRequest.options. More… | |
Public Member Functions | |
| ExportRecordsToTableRequest () | |
| Constructs an ExportRecordsToTableRequest object with default parameters. | |
| ExportRecordsToTableRequest (string table_name, string remote_query=null, IDictionary< string, string > options=null) | |
| Constructs an ExportRecordsToTableRequest object with the specified parameters. | |
| ExportRecordsToTableRequest () | |
| Constructs an ExportRecordsToTableRequest object with default parameters. | |
| ExportRecordsToTableRequest (string table_name, string remote_query=null, IDictionary< string, string > options=null) | |
| Constructs an ExportRecordsToTableRequest object with the specified parameters. | |
| Public Member Functions inherited from kinetica.KineticaData | |
| KineticaData (KineticaType type) | |
| Constructor from Kinetica Type. | |
| KineticaData (System.Type type=null) | |
| Default constructor, with optional System.Type. | |
| object | Get (int fieldPos) |
| Retrieve a specific property from this object. | |
| void | Put (int fieldPos, object fieldValue) |
| Write a specific property to this object. | |
| KineticaData (KineticaType type) | |
| Constructor from Kinetica Type. | |
| KineticaData (System.Type type=null) | |
| Default constructor, with optional System.Type. | |
| object | Get (int fieldPos) |
| Retrieve a specific property from this object. | |
| void | Put (int fieldPos, object fieldValue) |
| Write a specific property to this object. | |
Properties | |
| string | table_name [get, set] |
| Name of the table from which the data will be exported to remote database, in [schema_name. | |
| string | remote_query = "" [get, set] |
| Parameterized insert query to export gpudb table data into remote database. | |
| IDictionary< string, string > | options = new Dictionary<string, string>() [get, set] |
| Optional parameters. | |
| Properties inherited from kinetica.KineticaData | |
| Schema | Schema [get] |
| Avro Schema for this class. | |
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. | |
| static ? RecordSchema | SchemaFromType (System.Type t, KineticaType? ktype=null) |
| Create an Avro Schema from a System.Type and a KineticaType. | |
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]
| inline |
Constructs an ExportRecordsToTableRequest object with default parameters.
Definition at line 203 of file ExportRecordsToTable.cs.
◆ ExportRecordsToTableRequest() [2/4]
| 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.
|
Definition at line 303 of file ExportRecordsToTable.cs.
◆ ExportRecordsToTableRequest() [3/4]
| inline |
Constructs an ExportRecordsToTableRequest object with default parameters.
Definition at line 203 of file ExportRecordsToTable.cs.
◆ ExportRecordsToTableRequest() [4/4]
| 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.
|
Definition at line 303 of file ExportRecordsToTable.cs.
Property Documentation
◆ 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 ExportRecordsToTableRequest.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: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 FALSE.
The default value is an empty Dictionary.
Definition at line 199 of file ExportRecordsToTable.cs.
◆ remote_query
| getset |
Parameterized insert query to export gpudb table data into remote database.
The default value is ”.
Definition at line 107 of file ExportRecordsToTable.cs.
◆ 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 102 of file ExportRecordsToTable.cs.
The documentation for this class was generated from the following files:
- _build/public-os_ubuntu24.04-arch_amd64-cc_gcc_13.3.0/install/Kinetica/Protocol/ExportRecordsToTable.cs
- Kinetica/Protocol/ExportRecordsToTable.cs