A set of parameters for GPUdb::exportRecordsToTable. More…
#include <gpudb/protocol/export_records_to_table.h>
Public Member Functions | |
| ExportRecordsToTableRequest () | |
| Constructs an ExportRecordsToTableRequest object with default parameters. | |
| ExportRecordsToTableRequest (const std::string &tableName_, const std::string &remoteQuery_, const std::map< std::string, std::string > &options_) | |
| Constructs an ExportRecordsToTableRequest object with the specified parameters. | |
Public Attributes | |
| std::string | tableName |
| 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. | |
| std::string | remoteQuery |
| Parameterized insert query to export gpudb table data into remote database. | |
| std::map< std::string, std::string > | options |
| Optional parameters. | |
Detailed Description
A set of parameters for GPUdb::exportRecordsToTable.
Exports records from source table to the specified target table in an external database.
Definition at line 19 of file export_records_to_table.h.
Constructor & Destructor Documentation
◆ ExportRecordsToTableRequest() [1/2]
| inline |
Constructs an ExportRecordsToTableRequest object with default parameters.
Definition at line 25 of file export_records_to_table.h.
◆ ExportRecordsToTableRequest() [2/2]
| inline |
Constructs an ExportRecordsToTableRequest object with the specified parameters.
| [in] | tableName_ | 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. |
| [in] | remoteQuery_ | Parameterized insert query to export gpudb table data into remote database. The default value is ”. |
| [in] | options_ | Optional parameters.
|
Definition at line 116 of file export_records_to_table.h.
Member Data Documentation
◆ options
| std::map<std::string, std::string> gpudb::ExportRecordsToTableRequest::options |
Optional parameters.
- export_records_to_table_batch_size: Batch size, which determines how many rows to export per round trip. The default value is ‘200000’.
- export_records_to_table_datasink_name: Name of an existing external data sink to which table name specified in tableName will be exported.
- export_records_to_table_jdbc_session_init_statement: Executes the statement per each JDBC session before doing actual load. The default value is ”.
- export_records_to_table_jdbc_connection_init_statement: Executes the statement once before doing actual load. The default value is ”.
- export_records_to_table_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 ”.
- export_records_to_table_use_st_geomfrom_casts: Wraps parameterized variables with st_geomfromtext or st_geomfromwkb based on source column type. Supported values:The default value is export_records_to_table_false.
- export_records_to_table_use_indexed_parameters: Uses $n style syntax when generating insert query for remote_table option. Supported values:The default value is export_records_to_table_false.
The default value is an empty map.
Definition at line 194 of file export_records_to_table.h.
◆ remoteQuery
| std::string gpudb::ExportRecordsToTableRequest::remoteQuery |
Parameterized insert query to export gpudb table data into remote database.
The default value is ”.
Definition at line 135 of file export_records_to_table.h.
◆ tableName
| std::string gpudb::ExportRecordsToTableRequest::tableName |
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 129 of file export_records_to_table.h.
The documentation for this struct was generated from the following file:
- gpudb/protocol/export_records_to_table.h