Skip to main content

Class ExportRecordsToTableRequest

java.lang.Object
com.gpudb.protocol.ExportRecordsToTableRequest
All Implemented Interfaces:
org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecord

public class ExportRecordsToTableRequest extends Object implements org.apache.avro.generic.IndexedRecord
A set of parameters for GPUdb.exportRecordsToTable.

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

  • Constructor Details

    • ExportRecordsToTableRequest

      public ExportRecordsToTableRequest()
      Constructs an ExportRecordsToTableRequest object with default parameters.
    • ExportRecordsToTableRequest

      public ExportRecordsToTableRequest(String tableName, String remoteQuery, Map<String,String> options)
      Constructs an ExportRecordsToTableRequest object with the specified parameters.
      Parameters:
      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.
      remoteQuery - 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 tableName 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 Map.
  • Method Details

    • getClassSchema

      public static org.apache.avro.Schema getClassSchema()
      This method supports the Avro framework and is not intended to be called directly by the user.
      Returns:
      The schema for the class.
    • getTableName

      public String getTableName()
      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.
      Returns:
      The current value of tableName.
    • setTableName

      public ExportRecordsToTableRequest setTableName(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.
      Parameters:
      tableName - The new value for tableName.
      Returns:
      this to mimic the builder pattern.
    • getRemoteQuery

      public String getRemoteQuery()
      Parameterized insert query to export gpudb table data into remote database. The default value is ”.
      Returns:
      The current value of remoteQuery.
    • setRemoteQuery

      public ExportRecordsToTableRequest setRemoteQuery(String remoteQuery)
      Parameterized insert query to export gpudb table data into remote database. The default value is ”.
      Parameters:
      remoteQuery - The new value for remoteQuery.
      Returns:
      this to mimic the builder pattern.
    • getOptions

      public Map<String,String> getOptions()
      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 tableName 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 Map.
      Returns:
      The current value of options.
    • setOptions

      public ExportRecordsToTableRequest setOptions(Map<String,String> 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 tableName 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 Map.
      Parameters:
      options - The new value for options.
      Returns:
      this to mimic the builder pattern.
    • getSchema

      public org.apache.avro.Schema getSchema()
      This method supports the Avro framework and is not intended to be called directly by the user.
      Specified by:
      getSchema in interface org.apache.avro.generic.GenericContainer
      Returns:
      The schema object describing this class.
    • get

      public Object get(int index)
      This method supports the Avro framework and is not intended to be called directly by the user.
      Specified by:
      get in interface org.apache.avro.generic.IndexedRecord
      Parameters:
      index - the position of the field to get
      Returns:
      value of the field with the given index.
      Throws:
    • put

      public void put(int index, Object value)
      This method supports the Avro framework and is not intended to be called directly by the user.
      Specified by:
      put in interface org.apache.avro.generic.IndexedRecord
      Parameters:
      index - the position of the field to set
      value - the value to set
      Throws:
    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object
    • toString

      public String toString()
      Overrides:
      toString in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object